/*
 * Copyright (c) 2005, Eric Crahen
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is furnished
 * to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */

#ifndef __ZTPRIORITYCONDITION_H__
#define __ZTPRIORITYCONDITION_H__

#include "zthread/Lockable.h"
#include "zthread/NonCopyable.h"
#include "zthread/Waitable.h"

namespace ZThread {

  class PriorityConditionImpl;

  /**
   * @class PriorityCondition
   * @author Eric Crahen <http://www.code-foo.com>
   * @date <2003-07-16T17:35:28-0400>
   * @version 2.2.1
   *
   * A PriorityCondition is a Condition that is sensitive to thread priority.
   *
   * @see Condition
   *
   * <b>Scheduling</b>
   *
   * Threads blocked on a PriorityCondition are resumed in priority order, highest priority
   * first
   */
  class ZTHREAD_API PriorityCondition : public Waitable, private NonCopyable {

    PriorityConditionImpl* _impl;

  public:

    /**
     * @see Condition::Condition(Lockable& l)
     */
    PriorityCondition(Lockable& l);

    /**
     * @see Condition::~Condition()
     */
    ~PriorityCondition();

    /**
     * @see Condition::signal()
     */
    void signal();

    /**
     * @see Condition::broadcast()
     */
    void broadcast();

    /**
     * @see Condition::wait()
     */
    virtual void wait();

    /**
     * @see Condition::wait(unsigned long timeout)
     */
    virtual bool wait(unsigned long timeout);

  };

} // namespace ZThread

#endif // __ZTPRIORITYCONDITION_H__

